home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / pcboard / hb_nc12.zip / NLCHECK.DOC < prev    next >
Text File  |  1996-01-06  |  8KB  |  242 lines
  1. NLCHECK.PPE Documentation
  2.  
  3. Nodelist update checker version 1.0
  4.  
  5. Author: Herbert Bushong
  6.    BBS: 318-468-3385
  7.   Fido: 1:19/19
  8.  I-net: herbert.bushong@bbread.pecan.com
  9.  
  10.  
  11. Copyright
  12. =========
  13.  
  14. Although freeware, this PPE is copyrighted and you are subject to all
  15. copyright laws. It is trojan and backdoor free. It works for me and should
  16. for you.
  17.  
  18.  
  19. Description
  20. ===========
  21.  
  22. I must update several nodelists weekly, and it was a real hassle to copy,
  23. extract, apply the diffs, and run PCBNLC every week (I do have better things
  24. to do <g>)
  25.  
  26. What NLCHECK does is create a BAT or CMD file. That's it. The BAT file
  27. will do all the work, and it's up to you to run the BAT file.
  28.  
  29. NLCHECK will only work with one extension at a time. If you have nodelists
  30. that are created on different days (thus different numbered extensions), you
  31. current will only be able to use NLCHECK for one set of them. If there
  32. is a demand, I can update it to handle that particular situation.
  33.  
  34. NLCHECK can handle multiple archive formats and even uncompressed files.
  35.  
  36. Installation
  37. ============
  38.  
  39. If you are upgrading from the PPE version, read the UPGRADE.TXT for 
  40. instructions.
  41.  
  42. Extract the files in the archive to a directory of your choice.
  43. Edit the CFG and LST files to match your setup. They are commented at the 
  44. end of each file.
  45.  
  46.  
  47. Execution
  48. =========
  49.  
  50. NLCHECK is best run from an event which runs ONCE a week, on the day the
  51. nodelists are created. For Fidonet (and most others) this day is Friday.
  52. In the event, add the following line:
  53.  
  54. d:\path\nlcheck.exe d:\path [/L] 
  55.  
  56. where: 
  57.     d:\path  -  points to the directory that the CFG and LST files are.
  58.     /L       -  if used, a log file will be created in the directory
  59.                 of d:\path. This file is appended to, so should be checked
  60.                 and deleted occassionally.
  61.  
  62. this will create a BAT or CMD file (see configuration for location)
  63. called NLCHECK.BAT (CMD). It will overwrite any previous NLCHECK.BAT.
  64.  
  65. You can then run NLCHECK.BAT manually from the command line, or in another
  66. weekly event to automatically update your nodelists. If you run the BAT file
  67. from another event, make sure you give all your diffs time to come in, though
  68. you can re-run the BAT file.
  69.  
  70. NLCHECK takes one additional parameter. You can override the day number
  71. by placing it on the command line, so:
  72.  
  73. d:\path\nlcheck.exe d:\path /D:300 [/L]
  74.  
  75. would create a BAT file for all nodediffs for day 300 rather than today's
  76. day number.
  77.  
  78.  
  79. Configuration
  80. =============
  81.  
  82. NLCHECK uses 3 configuration files. They are commented at the end of them,
  83. but an example and description of each follows.
  84.  
  85. NLCHECK.CFG  - main config file
  86. -----------
  87. D:\pcb\node2
  88. Y
  89. d:
  90. \pcb\fido\nodelist
  91. d:
  92. \pcb\node2
  93. N
  94.  
  95. Line 1 - Location to create batch file (will be named NLCHECK.BAT or CMD)
  96.          Since you may want to create the file in a directory other than
  97.          a node directory, this tells NLCheck where to create it. No trailing
  98.          backslash
  99.  
  100. Line 2 - Y/N, Y=BAT N=CMD
  101.          Tells NLCheck whether to create a DOS batch file, or an OS/2 CMD
  102.          File.
  103.  
  104. ;line 3 - The drive where your PCBFido nodelist directory resides
  105.           This is the drive where nodediffs will be copied to and extracted.
  106.  
  107. ;line 4 - path only to nodelist directory
  108.           Same as line 3, but only the path to the directory, with leading
  109.           backslash and no trailing backslash.
  110.  
  111. ;line 5 - drive where pcbnlc will be run from
  112.           This is the drive where PCBNLC will be run from with the /DIFF
  113.           parameter and then without.
  114.  
  115. ;line 6 - path only where pcbnlc will be run from
  116.           This should be a node directory, or a directory where a PCBOARD.DAT
  117.           resides.
  118.  
  119. ;line 7 - Y/N, Y=delete copied diffs after processing, N=leave diffs
  120.           If you want to keep the  diff copies, set this to N.
  121.           If you don't want to keep them, there are two methods.
  122.           Setting this to 'Y' will add DEL statements to the BAT file to
  123.           delete the archived and unpacked diffs.
  124.           Or, if the archiver supports it, the archiver can MOVE the
  125.           files out of the archive and delete them. PAK is an example of
  126.           an archiver that can do this.
  127.  
  128.  
  129. ARC.LST   -   Archiver Difinitions
  130. --------
  131.  
  132. 2
  133. A
  134. c:\bin\PAK x #ARC#
  135. Z
  136. c:\bin\pkunzip -o #ARC#
  137.  
  138.  
  139. ;Archiver definition file. Contains the definitions and the
  140. ;command line for each archiver. Use the special macro #ARC# to indicate
  141. ;placement of the archive filename (which will include the path)
  142.  
  143. Line 1 - Number of entries in the file
  144.  
  145. each entry has 2 lines
  146. Line 2 - Prefix
  147.          This is the prefix ( 1 character ) used for this archiver.
  148.           NODELIST.A14   -  indicates ARC format
  149.           NODELIST.Z14   -  indicates ZIP format
  150.          Add any others that you need.
  151.          **Note** The letter N is reserved to indicate uncompressed
  152.           lists.
  153.  
  154. Line 3 - Archiver command line for prefix
  155.          This is the command line to unarchive the file. In the above examples
  156.          PAK will move the files out of the archive and delete the archive.
  157.          PKUNZIP will extract the files and overwrite any existing diffs.
  158.  
  159. Repeat 2 & 3 for each Archive format that your nodelists come in.
  160.  
  161.  
  162. DIFF.LST  -  List of DIFF files to process
  163. ---------
  164.  
  165. 4
  166. d:\files\dl09\NODEDIFF
  167. d:\pcb\fido\nodelist\nodediff
  168. A
  169. d:\makenl\intel\INTEDIFF
  170. d:\pcb\fido\nodelist\intediff
  171. A
  172. d:\makenl\rebel\REBDIFF
  173. d:\pcb\fido\nodelist\rebdiff
  174. A
  175. d:\makenl\pclist\PCCDIFF
  176. d:\pcb\fido\nodelist\pccdiff
  177. A
  178.  
  179. ;Line 1 - number of entries
  180.  
  181. ;each entry has 3 lines
  182. ;Line 2 - location and Diff file basename (no extension)
  183.           Where the diff file can be found.
  184.  
  185. ;Line 3 - location and basename to COPY diff file to (no extension)
  186.           this should be your PCBFido Nodelist directory.
  187.  
  188. ;Line 4 - Archiver prefix.
  189.           This Letter corresponds to an entry in the ARC.LST file and
  190.           indicates which archive format the diff will be in.
  191.           It also replaces the first number of extension.
  192.           Must be listed in ARC.LST or N for no compression
  193.  
  194. Repeat lines 2-4 for each diff entry
  195.  
  196.  
  197. Sample NLCHECK.BAT
  198. ==================
  199. Here is a sample BAT file, created with my config files.
  200.  
  201. -------
  202. @ECHO OFF
  203.  
  204. IF NOT EXIST d:\files\dl09\NODEDIFF.A21 GOTO FILE1
  205. COPY d:\files\dl09\NODEDIFF.A21 d:\pcb\fido\nodelist\nodediff.A21
  206.  
  207. :FILE1
  208. IF NOT EXIST d:\makenl\intel\INTEDIFF.A21 GOTO FILE2
  209. COPY d:\makenl\intel\INTEDIFF.A21 d:\pcb\fido\nodelist\intediff.A21
  210.  
  211. :FILE2
  212. IF NOT EXIST d:\makenl\rebel\REBDIFF.A21 GOTO FILE3
  213. COPY d:\makenl\rebel\REBDIFF.A21 d:\pcb\fido\nodelist\rebdiff.A21
  214.  
  215. :FILE3
  216. IF NOT EXIST d:\makenl\pclist\PCCDIFF.A21 GOTO FILE4
  217. COPY d:\makenl\pclist\PCCDIFF.A21 d:\pcb\fido\nodelist\pccdiff.A21
  218. :FILE4
  219.  
  220. d:
  221. CD\pcb\fido\nodelist
  222.  
  223. c:\bin\PAK x d:\pcb\fido\nodelist\nodediff.A21
  224. c:\bin\PAK x d:\pcb\fido\nodelist\intediff.A21
  225. c:\bin\PAK x d:\pcb\fido\nodelist\rebdiff.A21
  226. c:\bin\PAK x d:\pcb\fido\nodelist\pccdiff.A21
  227.  
  228. d:
  229. CD\pcb\node1
  230.  
  231. PCBNLC /DIFF
  232. PCBNLC
  233. ----------
  234.  
  235. I run NLCheck.EXE in an event on Friday, then call NLCHECK.BAT from an event
  236. on Monday. This gives time for the files to come in and get posted before
  237. the diffs actually get applied.
  238.  
  239. That's all there is to it. If you have questions, suggestion, comments, I can
  240. be reached by one of the methods at the beginning of the docs.
  241.  
  242.